xr_api_defs.h File Reference

#include "xr_math.h"
#include <stdint.h>
#include <wchar.h>
#include <string>

Go to the source code of this file.

Classes
struct	SonyOzRect
	Rectangle. More...
struct	SonyOzDeviceInfo
	Device information. More...
struct	SonyOzMultiDisplayDeviceInfo
	連結設定時のデバイスの情報 More...
struct	SonyOzFovf
	FOV of rendering camear. More...
struct	SonyOzFrustumPlanesf
struct	SonyOzPosef
	pose(position, orientation) More...
struct	SonyOzHeadPosef
	Head pose. More...
struct	SonyOzDisplayResolution
	Display resolution. More...
struct	SonyOzDisplaySize
	Dispaly dimension. More...
struct	SonyOzProjectionMatrix
	Projection matrix. More...
struct	SonyOzDisplaySpec
	Display information. More...
struct	SonyOzXrSystemError
	Sytem error occurred in XR Runtime. More...
struct	SonyOzProjection

Macros
#define	XR_PTR_SIZE   4
#define	XR_DEFINE_HANDLE(object)

Typedefs
typedef const char *	SonyOzPlatformId
	ID indicating XR platform. It will always be "Spatial Reality Display".
typedef enum DXGI_FORMAT	DXGI_FORMAT

Enumerations
enum class	SonyOzResult {   SUCCESS = 0 , ERROR_RUNTIME_NOT_FOUND = -1 , ERROR_VALIDATION_FAILURE = -2 , ERROR_RUNTIME_FAILURE = -3 ,   ERROR_FUNCTION_UNSUPPORTED = -4 , ERROR_HANDLE_INVALID = -5 , ERROR_SESSION_CREATED = -6 , ERROR_SESSION_READY = -7 ,   ERROR_SESSION_STARTING = -8 , ERROR_SESSION_RUNNING = -9 , ERROR_SESSION_STOPPING = -10 , ERROR_SESSION_NOT_CREATE = -11 ,   ERROR_SESSION_NOT_READY = -12 , ERROR_SESSION_NOT_RUNNING = -13 , ERROR_SESSION_STILL_USED = -14 , ERROR_POSE_INVALID = -15 ,   ERROR_SET_DATA_FAILURE = -16 , ERROR_GET_DATA_FAILURE = -17 , ERROR_FILE_ACCESS_ERROR = -18 , ERROR_DEVICE_NOT_FOUND = -19 ,   ERROR_RUNTIME_UNSUPPORTED = -20 }
	Result of XR Runtime API. More...
enum class	SonyOzSessionState {   UNKNOWN = 0b00000000 , IDLE = 0b00000001 , READY = 0b00000010 , STARTING = 0b00000100 ,   RUNNING = 0b00001000 , STOPPING = 0b00010000 }
	session state More...
enum class	SonyOzMultiDisplayMode {   Single = 0 , Virtical = 1 , Horizontal = 2 , Grid = 3 ,   Clone = 4 , Multiple = 5 }
enum class	SonyOzXrSystemErrorResult : uint8_t { Success , Warning , Error }
	Type of error occurred in XR Runtime. More...
enum class	SonyOzPoseId : int32_t { HEAD = 0 , LEFT_EYE = 1 , RIGHT_EYE = 2 }
enum	DXGI_FORMAT { DXGI_FORMAT_UNKNOWN = 0 }

Variables
const float	kDefaultDisplayWidth_m = 0.3442176f
const float	kDefaultDisplayHeight_m = 0.1936224f
const float	kDefaultDisplayTilt_rad = 0.785398f
const uint32_t	kDefaultHorizontalResolution_px = 3840
const uint32_t	kDefaultVerticalResolution_px = 2160
const uint32_t	kDeviceSerialNumberMaxSize = 256
const uint32_t	kDeviceProductIdMaxSize = 256
constexpr uint16_t	kXrSystemErrorMsgSize = 512

Detailed Description

Copyright

Sony CONFIDENTIAL

Copyright 2019,2020,2021,2022 Sony Corporation

DO NOT COPY AND/OR REDISTRIBUTE WITHOUT PERMISSION.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `‘AS IS’' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

XR_DEFINE_HANDLE

#define XR_DEFINE_HANDLE

(

object

)

Value:

typedef uint64_t object;

XR_PTR_SIZE

#define XR_PTR_SIZE   4

Typedef Documentation

DXGI_FORMAT

typedef enum DXGI_FORMAT DXGI_FORMAT

SonyOzPlatformId

typedef const char* SonyOzPlatformId

ID indicating XR platform. It will always be "Spatial Reality Display".

Enumeration Type Documentation

DXGI_FORMAT

enum DXGI_FORMAT

Enumerator
DXGI_FORMAT_UNKNOWN

SonyOzMultiDisplayMode

enum class SonyOzMultiDisplayMode

strong

Enumerator
Single
Virtical
Horizontal
Grid
Clone
Multiple

SonyOzPoseId

enum class SonyOzPoseId : int32_t

strong

Enumerator
HEAD	Pose ID specifying the center between eyes.
LEFT_EYE	Pose ID specifying the left eye.
RIGHT_EYE	Pose ID specifying the right eye.

SonyOzResult

enum class SonyOzResult

strong

Result of XR Runtime API.

Enumerator
SUCCESS	Success.
ERROR_RUNTIME_NOT_FOUND	XR Runtime is not installed.
ERROR_VALIDATION_FAILURE	Invalid argument.
ERROR_RUNTIME_FAILURE	Problems with XR Runtime.
ERROR_FUNCTION_UNSUPPORTED	Unsupported function called.
ERROR_HANDLE_INVALID	Invalid handle.
ERROR_SESSION_CREATED	A session is already created.
ERROR_SESSION_READY	A session is already ready.
ERROR_SESSION_STARTING	A session is already starting.
ERROR_SESSION_RUNNING	A session is already running.
ERROR_SESSION_STOPPING	A session is already stopping.
ERROR_SESSION_NOT_CREATE	A session is not created.
ERROR_SESSION_NOT_READY	A session is not ready.
ERROR_SESSION_NOT_RUNNING	A session is not running.
ERROR_SESSION_STILL_USED	A session is still used.
ERROR_POSE_INVALID	Failed to obtain correct pose.
ERROR_SET_DATA_FAILURE	Failed to set data.
ERROR_GET_DATA_FAILURE	Failed to get data.
ERROR_FILE_ACCESS_ERROR	Failed to access the file.
ERROR_DEVICE_NOT_FOUND	Failed to find the device.
ERROR_RUNTIME_UNSUPPORTED	This API is not supported.

SonyOzSessionState

enum class SonyOzSessionState

strong

session state

Enumerator
UNKNOWN	Unknown state.
IDLE	The session is idle.
READY	The session is ready.
STARTING	The session is starting.
RUNNING	The session is running.
STOPPING	TBD.

SonyOzXrSystemErrorResult

enum class SonyOzXrSystemErrorResult : uint8_t

strong

Type of error occurred in XR Runtime.

Enumerator
Success
Warning
Error

Variable Documentation

kDefaultDisplayHeight_m

const float kDefaultDisplayHeight_m = 0.1936224f

kDefaultDisplayTilt_rad

const float kDefaultDisplayTilt_rad = 0.785398f

kDefaultDisplayWidth_m

const float kDefaultDisplayWidth_m = 0.3442176f

kDefaultHorizontalResolution_px

const uint32_t kDefaultHorizontalResolution_px = 3840

kDefaultVerticalResolution_px

const uint32_t kDefaultVerticalResolution_px = 2160

kDeviceProductIdMaxSize

const uint32_t kDeviceProductIdMaxSize = 256

kDeviceSerialNumberMaxSize

const uint32_t kDeviceSerialNumberMaxSize = 256

kXrSystemErrorMsgSize

uint16_t kXrSystemErrorMsgSize = 512

constexpr